Removed obsolete v6 APIs #4619

jamescrosswell · 2025-10-10T04:31:27Z

Resolves #4608

Remove Obsolete APIs for 6.0.0 #4608

For discussion

There are a couple of APIs left that are still marked as obsolete, which probably merit some discussion:

Extra

SentrySpan, SentryTransaction and TransactionTracer all have Extra members like:

sentry-dotnet/src/Sentry/SentrySpan.cs

Lines 82 to 84 in 748fcfe

    
           /// <inheritdoc /> 
        
           [Obsolete("Use Data")] 
        
           public IReadOnlyDictionary<string, object?> Extra => Data;

sentry-dotnet/src/Sentry/SentrySpan.cs

Lines 86 to 88 in 748fcfe

    
           /// <inheritdoc /> 
        
           [Obsolete("Use SetData")] 
        
           public void SetExtra(string key, object? value) => SetData(key, value);

Although we do probably want to get rid of these, as believe we also want to get rid of the Data members that we're recommending people switch to... since I think all of these will be replaced by Attributes at some stage right?

Possibly we delay replacing these until the new Attributes are available and, at that point, we could ship an Analyzer and a Code fix to help people migrate (since Extras may be used quite widely).

GetInternalSentryOptions

We also have this, which is a bit of a misuse of the ObsoleteAttribute:

sentry-dotnet/src/Sentry/SentryClientExtensions.cs

Lines 98 to 110 in 216bbc5

    
           /// <summary> 
        
           /// <para> 
        
           /// Gets internal SentryOptions for integrations like Hangfire that don't support strong assembly names. 
        
           /// </para> 
        
           ///<remarks> 
        
           /// *** This is not meant for external use !!! *** 
        
           /// </remarks>> 
        
           /// </summary> 
        
           /// <param name="clientOrHub"></param> 
        
           /// <returns></returns> 
        
           [Obsolete("WARNING: This method is meant for internal usage only")] 
        
           public static SentryOptions? GetInternalSentryOptions(this ISentryClient clientOrHub) => 
        
               clientOrHub.GetSentryOptions();

We could potentially replace it with this:

[InternalApi("For internal integrations like Hangfire only")]
[EditorBrowsable(EditorBrowsableState.Never)]
public static SentryOptions? GetInternalSentryOptions(this ISentryClient clientOrHub) =>
    clientOrHub.GetSentryOptions();

And then also ship a Roslyn Analyzer that warns if people use something decorated with InternalApiAttribute.

CrashType

Same again for the APIs designed to deliberately create a crash:

sentry-dotnet/src/Sentry/CrashType.cs

Lines 7 to 8 in bd62cf0

    
           [Obsolete("WARNING: This method deliberately causes a crash, and should not be used in a real application.")] 
        
           public enum CrashType

EnableWatchdogTerminationTracking

Not sure what we want to do with this. Is the long term plan to remove this functionality entirely or are we planning to address the issues with this and "unobsolete" it eventually?

sentry-dotnet/src/Sentry/Platforms/Cocoa/SentryOptions.cs

Lines 147 to 157 in 4a608d4

    
           /// <summary> 
        
           /// Whether to enable watchdog termination tracking or not. NOT advised. 
        
           /// The default value is <c>false</c> (disabled). 
        
           /// </summary> 
        
           /// <remarks> 
        
           /// This feature is prone to false positives on .NET since it relies on heuristics that don't work in this environment. 
        
           /// </remarks> 
        
           /// <seealso href="https://github.com/getsentry/sentry-dotnet/issues/3860" /> 
        
           /// <seealso href="https://docs.sentry.io/platforms/apple/configuration/watchdog-terminations/" /> 
        
           [Obsolete("See: https://github.com/getsentry/sentry-dotnet/issues/3860")] 
        
           public bool EnableWatchdogTerminationTracking { get; set; } = false;

In the meantime, do we want to remove it from the .NET API?

codecov · 2025-10-10T05:26:42Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (version6@33615f4). Learn more about missing BASE report.

Additional details and impacted files

@@             Coverage Diff             @@
##             version6    #4619   +/-   ##
===========================================
  Coverage            ?   73.04%           
===========================================
  Files               ?      478           
  Lines               ?    17315           
  Branches            ?     3422           
===========================================
  Hits                ?    12647           
  Misses              ?     3813           
  Partials            ?      855

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jamescrosswell added 4 commits October 10, 2025 17:14

Removed UserFeedback

216bbc5

Removed obsolete BreadcrumbEvent constructor

2bec67a

Updated unit tests

214ee99

Changelog

8ec88e8

Update ApiApprovalTests.Run.Net4_8.verified.txt

e6a8fa2

jamescrosswell marked this pull request as ready for review October 10, 2025 09:18

jamescrosswell requested a review from Flash0ver as a code owner October 10, 2025 09:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Removed obsolete v6 APIs #4619

Removed obsolete v6 APIs #4619

Uh oh!

jamescrosswell commented Oct 10, 2025

Uh oh!

codecov bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	/// <inheritdoc />
	[Obsolete("Use Data")]
	public IReadOnlyDictionary<string, object?> Extra => Data;

	/// <inheritdoc />
	[Obsolete("Use SetData")]
	public void SetExtra(string key, object? value) => SetData(key, value);

	/// <summary>
	/// <para>
	/// Gets internal SentryOptions for integrations like Hangfire that don't support strong assembly names.
	/// </para>
	///<remarks>
	/// * This is not meant for external use !!! *
	/// </remarks>>
	/// </summary>
	/// <param name="clientOrHub"></param>
	/// <returns></returns>
	[Obsolete("WARNING: This method is meant for internal usage only")]
	public static SentryOptions? GetInternalSentryOptions(this ISentryClient clientOrHub) =>
	clientOrHub.GetSentryOptions();

	[Obsolete("WARNING: This method deliberately causes a crash, and should not be used in a real application.")]
	public enum CrashType

	/// <summary>
	/// Whether to enable watchdog termination tracking or not. NOT advised.
	/// The default value is <c>false</c> (disabled).
	/// </summary>
	/// <remarks>
	/// This feature is prone to false positives on .NET since it relies on heuristics that don't work in this environment.
	/// </remarks>
	/// <seealso href="https://github.com/getsentry/sentry-dotnet/issues/3860" />
	/// <seealso href="https://docs.sentry.io/platforms/apple/configuration/watchdog-terminations/" />
	[Obsolete("See: https://github.com/getsentry/sentry-dotnet/issues/3860")]
	public bool EnableWatchdogTerminationTracking { get; set; } = false;

Uh oh!

Removed obsolete v6 APIs #4619

Are you sure you want to change the base?

Removed obsolete v6 APIs #4619

Uh oh!

Conversation

jamescrosswell commented Oct 10, 2025

For discussion

Extra

GetInternalSentryOptions

CrashType

EnableWatchdogTerminationTracking

Uh oh!

codecov bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

codecov bot commented Oct 10, 2025 •

edited

Loading